Package com.cisco.pt.ipc.sim.impl
Class DeviceImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.DeviceImpl
- Direct Known Subclasses:
CiscoDeviceImpl,CloudImpl,IoeImpl,MCUImpl,PcImpl,RemoteNetworkImpl
Information provided by the PKI file:
\class Device
\brief Device is the base class for all device objects.
\example network().getDevice("Router0")
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionDeviceImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:voidaddCustomVar(String name, String var) Information provided by the PKI file:voidaddDeviceExternalAttributes(String attributeValues) Information provided by the PKI file:booleanaddModule(String slot, ModuleType type, String model) Information provided by the PKI file:voidaddProgrammingSerialOutputs(String output) Information provided by the PKI file:voidInformation provided by the PKI file:addUserDesktopApp(String dirName) voidvoidInformation provided by the PKI file:voidInformation provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getCustomVarNameAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:getCustomVarStr(String name) Information provided by the PKI file:getCustomVarValueStrAt(int index) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:doublegetDeviceExternalAttributeValue(String attribute) Information provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:getModel()Information provided by the PKI file:getName()Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getPortAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:getPorts()Information provided by the PKI file:booleangetPower()Information provided by the PKI file:getProcess(String process) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getType()Information provided by the PKI file:longInformation provided by the PKI file:getUsbPortAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:getUserDesktopAppAt(int index) getUserDesktopAppByDir(String dirName) intdoubleInformation provided by the PKI file:intInformation provided by the PKI file:doubleInformation provided by the PKI file:intInformation provided by the PKI file:booleanhasCustomVar(String name) Information provided by the PKI file:booleanbooleanInformation provided by the PKI file:booleanisProjectRunning(String projectName) Information provided by the PKI file:booleanmoveByInPhysicalWS(int x, int y) Information provided by the PKI file:booleanmoveToLocation(int x, int y) Information provided by the PKI file:booleanmoveToLocationCentered(int x, int y) Information provided by the PKI file:booleanmoveToLocInPhysicalWS(int x, int y) Information provided by the PKI file:voidInformation provided by the PKI file:voidrelinkUserDesktopApp(String oldDirName, String newDirName) booleanremoveCustomVar(String name) Information provided by the PKI file:booleanremoveModule(String slot) Information provided by the PKI file:voidremoveUserDesktopApp(String dirName) booleanrestoreToDefault(boolean bMakeCopy, boolean bMarkCustomizedUpdated) Information provided by the PKI file:booleanrunCodeInProject(String projectName, String code) Information provided by the PKI file:booleanrunProject(String projectName, String extraCode) Information provided by the PKI file:Information provided by the PKI file:voidsetCustomInterface(String inf) Information provided by the PKI file:voidsetCustomLogicalImage(String strPath) Information provided by the PKI file:voidsetCustomPhysicalImage(String strPath) Information provided by the PKI file:voidsetDeviceExternalAttributes(String attributeValues) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetPower(boolean bOn) Information provided by the PKI file:voidsetTime(int uiHour, int uiMin, int uiSec, int uiDay, int uiMonth, int uiYear) Information provided by the PKI file:booleanstopProject(String projectName) Information provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidsubtractDeviceExternalAttributes(String attributeValues) Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
DeviceImpl
public DeviceImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setName
Information provided by the PKI file:
\brief Sets the display name of this device. \param name, the display name string. -
getName
Information provided by the PKI file:
\brief Returns the display name of this device. \return QString, the display name of this device. -
setPower
public void setPower(boolean bOn) Information provided by the PKI file:
\brief Sets the power on or off. \param bOn, true to set the power on, false to set the power off. -
addSound
Information provided by the PKI file:
\brief Adds sound to the device \param soundPath, the path to the sound file \param soundId, the id to identify the sound from other sounds -
playSound
Information provided by the PKI file:
\brief Play sound to the device \param soundID, the id of the sounpath to the sound file \param numLoop, the number of times to play the sound -
stopSound
Information provided by the PKI file:
\brief Stop playing sound on the device \param soundID, the id of the sounpath to the sound file -
stopSounds
public void stopSounds()Information provided by the PKI file:
\brief Stops playing all sounds on the device- Specified by:
stopSoundsin interfaceDevice
-
destroySounds
public void destroySounds()Information provided by the PKI file:
\brief Destroy all of the sounds on the device- Specified by:
destroySoundsin interfaceDevice
-
getPower
public boolean getPower()Information provided by the PKI file:
\brief Returns the current power state of this device. \return bool, true if the power is on, otherwise false. -
getXCoordinate
public double getXCoordinate()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Logical workspace for this device. \return double, the current x-coordinate.- Specified by:
getXCoordinatein interfaceDevice- Returns:
- double Returns a double
-
getYCoordinate
public double getYCoordinate()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Logical workspace for this device. \return double, the current y-coordinate.- Specified by:
getYCoordinatein interfaceDevice- Returns:
- double Returns a double
-
getCenterXCoordinate
public double getCenterXCoordinate()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Logical workspace for this device. \return double, the current x-coordinate.- Specified by:
getCenterXCoordinatein interfaceDevice- Returns:
- double Returns a double
-
getCenterYCoordinate
public double getCenterYCoordinate()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Logical workspace for this device. \return double, the current y-coordinate.- Specified by:
getCenterYCoordinatein interfaceDevice- Returns:
- double Returns a double
-
getAreaTopY
public double getAreaTopY()Information provided by the PKI file:
\brief Returns the current topmost y-coordinate position in the for this device. \return double, the current y-coordinate.- Specified by:
getAreaTopYin interfaceDevice- Returns:
- double Returns a double
-
getAreaLeftX
public double getAreaLeftX()Information provided by the PKI file:
\brief Returns the current leftmost x-coordinate position in the for this device. \return double, the current x-coordinate.- Specified by:
getAreaLeftXin interfaceDevice- Returns:
- double Returns a double
-
moveToLocationCentered
public boolean moveToLocationCentered(int x, int y) Information provided by the PKI file:
\brief Moves this device to the specified location for its center in Logical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Specified by:
moveToLocationCenteredin interfaceDevice- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
moveToLocation
public boolean moveToLocation(int x, int y) Information provided by the PKI file:
\brief Moves this device to the specified location in Logical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Specified by:
moveToLocationin interfaceDevice- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
getXPhysicalWS
public int getXPhysicalWS()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Physical workspace for this device. \return int, the current x-cordinate.- Specified by:
getXPhysicalWSin interfaceDevice- Returns:
- int Returns a int
-
getYPhysicalWS
public int getYPhysicalWS()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Physical workspace for this device. \return int, the current y-coordinate.- Specified by:
getYPhysicalWSin interfaceDevice- Returns:
- int Returns a int
-
getGlobalXPhysicalWS
public double getGlobalXPhysicalWS()Information provided by the PKI file:
\brief Returns the current global x-coordinate position in the Physical workspace for this device. \return double, the current global x-cordinate.- Specified by:
getGlobalXPhysicalWSin interfaceDevice- Returns:
- double Returns a double
-
getGlobalYPhysicalWS
public double getGlobalYPhysicalWS()Information provided by the PKI file:
\brief Returns the current global y-coordinate position in the Physical workspace for this device. \return double, the current global y-coordinate.- Specified by:
getGlobalYPhysicalWSin interfaceDevice- Returns:
- double Returns a double
-
moveToLocInPhysicalWS
public boolean moveToLocInPhysicalWS(int x, int y) Information provided by the PKI file:
\brief Moves this device to the specified location in Physical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Specified by:
moveToLocInPhysicalWSin interfaceDevice- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
moveByInPhysicalWS
public boolean moveByInPhysicalWS(int x, int y) Information provided by the PKI file:
\brief Moves this device by the specified amount in Physical workspace. \param x, the x-amount to move by. \param y, the y-amount to move by. \return bool, true if successful, otherwise false.- Specified by:
moveByInPhysicalWSin interfaceDevice- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
getType
Information provided by the PKI file:
\brief Returns the type of this device. \return DeviceType, the type of this device. Device types: eRouter = 0, eSwitch = 1, eCloud = 2, eBridge = 3, eHub = 4, eRepeater = 5, eCoAxialSplitter = 6, eAccessPoint = 7, ePc = 8, eServer = 9, ePrinter = 10, eWirelessRouter = 11, eIpPhone = 12, eDslModem = 13, eCableModem = 14, eRemoteNetwork = 15, eMultiLayerSwitch = 16, eSwitch3650 = 17, eLaptop = 18, eTabletPC = 19, ePda = 20, eWirelessEndDevice = 21, eWiredEndDevice = 22, eTV = 23, eHomeVoip = 24, eAnalogPhone = 25, eMultiUser = 26, eASA = 27, eIoE = 28, eHomeGateway = 29, eWirelessRouterNewGeneration = 30, eCellTower = 31, eCentralOfficeServer = 32, eCiscoAccessPoint = 33, eEmbeddedCiscoAccessPoint = 34, eSniffer = 35, eMCU = 36, eSBC = 37, eThing = 38, eMCUComponent = 39, eEmbeddedServer = 40, eWirelessLanController = 41, eCluster = 42, eGeoIcon = 43, eLightWeightAccessPoint = 44, ePowerDistributionDevice = 45, ePatchPanel = 46, eWallMount = 47, eSecurityAppliance = 48, eMerakiServer = 49 -
getModel
Information provided by the PKI file:
\brief Returns the model of this device. \return string, the model of this device. -
getDescriptor
Information provided by the PKI file:
\brief Returns the device descriptor that user can get information on the device like type, model, module supported.. \return DeviceDescriptor, DeviceDescriptor object- Specified by:
getDescriptorin interfaceDevice- Returns:
- DeviceDescriptor Returns a DeviceDescriptor
-
getSerialNumber
Information provided by the PKI file:
\brief Returns the device serial number. \return string, device serial number in string format- Specified by:
getSerialNumberin interfaceDevice- Returns:
- String Returns a String
-
getPort
Information provided by the PKI file:
\brief Returns the Port object with the specified port name. \param portName, portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return Port, the Port object associated with the port name. -
getPortCount
public int getPortCount()Information provided by the PKI file:
\brief Returns the number of ports in this device. \return int, the number of ports in this device.- Specified by:
getPortCountin interfaceDevice- Returns:
- int Returns a int
-
getPortAt
Information provided by the PKI file:
\brief Returns the Port object at the specified index. \param int index, the index of the port of interest. \return Port, the Port object at the specified index. -
getProcess
Information provided by the PKI file:
\brief Returns the Process object associated the process name. \param process, the name of the process. Valid process names. Not all names have an interface to interact with. Only get names for which there are interfaces. The word "Process" is optional and may be appended to the end or ommitted.: Aaa, AcsServer, RadiusClient, RadiusServer, TacacsClient, TacacsServer, Acl, Aclv6, PingTcp, Settings, AnalogPhoneHandler, AnalogPhone, ArpLookUp, Arp, AsaAcl, AsaAclv6, Firewall, Firewallv6, AsaNat, AsaNatv6, Bgp, BluetoothManager, CustomBluetooth, Bridge, BVIManager, CapwapAC, Capwap, Cbac, Cbacv6, Cdp, CellularClientManager, CellularClient, Cellular, COPapChapAuthenticator, ParserViewManager, PrivilegeManager, PortMapped, DhcpClient, DhcpRelayAgent, DhcpServerMain, DhcpServer, DhcpSnoopingBindingDBAgent, DhcpSnooping, Dhcpv6Client, Dhcpv6Main, Dhcpv6ServerMain, Dhcpv6Server, DnsClient, DnsResolver, DnsServer, Dtp, EigrpMain, Eigrp, Eigrpv6Main, Eigrpv6, EtherChannel, EtherChannelDispatcher, EtherChannelManager, Lacp, Pagp, CsmaCd, Dot1QEncap, Dot1QSubIntDispatcher, EthernetEncap, FileManager, DlciLookUp, FrameRelayMain, FrameRelay, FRSubIntDispatcher, InvArp, LmiSignaling, FtpClient, FtpServer, Gre, TunnelInterface, Hdlc, Hsrp, Hsrpv6, HttpBackgroundClient, HttpBackgroundClientManager, HttpClient, HttpProxy, HttpServer, HttpsServer, IoxServer, WebSocketClient, Wlc2504HttpsServer, Wlc2504Server, Icmp, Ping, TraceRoute, Icmpv6, CustomIO, IoeClient, IoEComponent, Ioe, IoeServer, IoeUserManager, IoxGuestOs, UserApp, UserJsApp, UserPyApp, HostIp, IpFragmentation, Ips, HostIpv6, Ipv6Fragmentation, PMTUDiscovery, Ipv6Ip, IsatapClient, L2Nat, LinksysRouterEventHandler, Lldp, Loopback, LoopbackManager, EmailClient, EmailServer, Nat, NatV6, Nd, NeighborLookUp, Netflow, Netflowv6, NFCollector, NFExporter, NtpClient, NtpServer, OspfMain, Ospf, Ospfv3Main, Ospfv3, Pop3Client, Pop3Server, InterfaceStatus, PortKeepAlive, Chap, PAP, PhoneSignaling, PppMain, Ppp, DialerInterface, DialerInterfaceManager, PppoeClient, PppoeClientManager, Pppoe, PppoeServer, VirtualAccessInterface, VirtualTemplateInterface, VirtualTemplateManager, PTP, Rep, CableSignaling, CloudSwitcher, DslSignaling, Forwarding, LoopBreaker, PatchWire, Repeater, Rip, Ripv6Main, Ripv6, IpUnnumberDispatcher, PortDispatcher, Routing, RoutingProtocol, RoutingProcessv6, Security, SmtpClient, SmtpServer, SnmpAgent, SnmpManager, SshClient, SshServer, StpMain, Stp, MacSwitcher, PortSecurity, SdmManager, Span, SpanDest, SpanDestLocalPort, SpanSource, SpanSourceLocalPort, SpanSourceLocalPortChannel, SpanSourceLocalVlan, VlanManager, WLCMacSwitcher, SyslogClient, SyslogServer, CustomTcp, Tcp, TcpUserTraffic, ReverseTelnet, TelnetClient, TelnetServer, TftpClient, TftpServer, TftpSession, TftpSessionManager, Tv, CustomUdp, Udp, UdpTraceRoute, UsbController, CME, H323Client, H323, H323Server, PhoneMedia, Rtp, SccpClient, SccpServer, VoiceSwitcher, Ah, EasyVpnClient, EasyVpnServer, Esp, Ike, Ipsec, Vtp, AccessPointSwitcher, CsmaCa, LWAccessPointSwitcher, LWWirelessServer, WEP, WirelessClient, WirelessCommon, WirelessEncap, WirelessServerManager, WirelessServer, WLCServer, WPA, Zfw, Zfwv6 \return Process, the Process object associated with the process name.- Specified by:
getProcessin interfaceDevice- Parameters:
process- Takes in a parameter of process- Returns:
- Process Returns a Process
-
getUsbPortCount
public int getUsbPortCount()Information provided by the PKI file:
\brief Return the number of usb port \return int, number of usb port- Specified by:
getUsbPortCountin interfaceDevice- Returns:
- int Returns a int
-
getUsbPortAt
Information provided by the PKI file:
\brief Returns the usb port at a specified index \return int, index of the usb port- Specified by:
getUsbPortAtin interfaceDevice- Parameters:
index- Takes in a parameter of index- Returns:
- UsbPort Returns a UsbPort
-
getRootModule
Information provided by the PKI file:
\brief Returns the root module of the device. \return Module, The root module object.- Specified by:
getRootModulein interfaceDevice- Returns:
- Module Returns a Module
-
addModule
Information provided by the PKI file:
\brief Adds a specific module to a particular slot. \param slot, the slot to add the module to. \param type, the type of the module. Module types: eLineCard = 0, eNetworkModule = 1, eInterfaceCard = 2, ePtRouterModule = 3, ePtSwitchModule = 4, ePtCloudModule = 5, ePtRepeaterModule = 6, ePtHostModule = 7, ePtModemModule = 8, ePtLaptopModule = 9, ePtTVModule = 10, eIpPhonePowerAdapter = 11, ePtTabletPCModule = 12, ePtPdaModule = 13, ePtWirelessEndDeviceModule = 14, ePtWiredEndDeviceModule = 15, eTrs35 = 16, eUsb = 17, eNonRemovableModule = 18, eASAPowerAdapter = 19 \param model, the model name of the module. \return bool, true if successful, otherwise false. -
removeModule
Information provided by the PKI file:
\brief Removes the module from the slot. \param slot, the slot to remove the module from. \return bool, true if successful, otherwise false.- Specified by:
removeModulein interfaceDevice- Parameters:
slot- Takes in a parameter of slot- Returns:
- boolean Returns a boolean
-
getCommandLine
Information provided by the PKI file:
\brief Returns the command line TerminalLine object. \return TerminalLine, the TerminalLine object.- Specified by:
getCommandLinein interfaceDevice- Returns:
- TerminalLine Returns a TerminalLine
-
addCustomVar
Information provided by the PKI file:
\brief Adds a custom variable. \param name, the name of the variable. \param var, the value of the variable.- Specified by:
addCustomVarin interfaceDevice- Parameters:
name- Takes in a parameter of namevar- Takes in a parameter of var
-
removeCustomVar
Information provided by the PKI file:
\brief Removes a custom variable. \param name, the name of the variable. \return bool, true if successful, otherwise, false.- Specified by:
removeCustomVarin interfaceDevice- Parameters:
name- Takes in a parameter of name- Returns:
- boolean Returns a boolean
-
hasCustomVar
Information provided by the PKI file:
\brief Returns true if this device has a custom variable with the specified name. \param name, the name of the variable of interest. \param var, true if this device has a custom variable with the specified name.- Specified by:
hasCustomVarin interfaceDevice- Parameters:
name- Takes in a parameter of name- Returns:
- boolean Returns a boolean
-
getCustomVarStr
Information provided by the PKI file:
\brief Returns the value of the variable with the specified name. \param name, the name of the variable of interest. \param QString, the value of the custom variable.- Specified by:
getCustomVarStrin interfaceDevice- Parameters:
name- Takes in a parameter of name- Returns:
- String Returns a String
-
getCustomVarsCount
public int getCustomVarsCount()Information provided by the PKI file:
\brief Returns the number of custom variables this device has. \param QString, the number of custom variables this device has.- Specified by:
getCustomVarsCountin interfaceDevice- Returns:
- int Returns a int
-
getCustomVarNameAt
Information provided by the PKI file:
\brief Returns the name of the custom variable at the specified index. \param index, the index of the variable of interest. \param QString, the name of the custom variable at the specified index.- Specified by:
getCustomVarNameAtin interfaceDevice- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
getCustomVarValueStrAt
Information provided by the PKI file:
\brief Returns the value of the custom variable at the specified index. \param index, the index of the variable of interest. \param QString, the value of the custom variable at the specified index.- Specified by:
getCustomVarValueStrAtin interfaceDevice- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
setCustomInterface
Information provided by the PKI file:
\brief Set custom interface to the device \param QString, the custom interface name- Specified by:
setCustomInterfacein interfaceDevice- Parameters:
inf- Takes in a parameter of inf
-
getCustomInterface
Information provided by the PKI file:
\brief Get custom interface name on the device \return QString, the custom interface name- Specified by:
getCustomInterfacein interfaceDevice- Returns:
- String Returns a String
-
serializeToXml
Information provided by the PKI file:
\brief Returns the serialization string of this device. \param QString, the serialization string of this device.- Specified by:
serializeToXmlin interfaceDevice- Returns:
- String Returns a String
-
activityTreeToXml
Information provided by the PKI file:
\brief Returns the serialization string of this device's activity tree. \param QString, the serialization string of this device activity tree.- Specified by:
activityTreeToXmlin interfaceDevice- Returns:
- String Returns a String
-
getPhysicalObject
Information provided by the PKI file:
\brief Get custom interface name on the device \return QString, the custom interface name- Specified by:
getPhysicalObjectin interfaceDevice- Returns:
- PhysicalObject Returns a PhysicalObject
-
getCustomLogicalImage
Information provided by the PKI file:
\brief Get custom logical image path \return QString, the custom logical image name- Specified by:
getCustomLogicalImagein interfaceDevice- Returns:
- String Returns a String
-
setCustomLogicalImage
Information provided by the PKI file:
\brief Set custom logical image path \param strPath, the path to the custom logical image- Specified by:
setCustomLogicalImagein interfaceDevice- Parameters:
strPath- Takes in a parameter of strPath
-
getCustomPhysicalImage
Information provided by the PKI file:
\brief Get custom physical image path \return QString, custom physical image name in string- Specified by:
getCustomPhysicalImagein interfaceDevice- Returns:
- String Returns a String
-
setCustomPhysicalImage
Information provided by the PKI file:
\brief Set custom physical image path \param strPath, custom physical image name in string- Specified by:
setCustomPhysicalImagein interfaceDevice- Parameters:
strPath- Takes in a parameter of strPath
-
getSupportedModule
Information provided by the PKI file:
\brief Get a vector of supported modules \return vector<string>, a vector of supported module info with id and image path name in string format- Specified by:
getSupportedModulein interfaceDevice- Returns:
- List<String> Returns a List<String>
-
setTime
public void setTime(int uiHour, int uiMin, int uiSec, int uiDay, int uiMonth, int uiYear) Information provided by the PKI file:
\brief Set time to the device \param iuHour, hour in integer \param uiMin, minute in integer \param uiSec, second in integer \param uiDay, day in integer \param uiMonth, month in integer \param uiYear, year in integer -
getUpTime
public long getUpTime()Information provided by the PKI file:
\brief Set time to the device \return vector<string>, vector of port names in string format -
getPorts
Information provided by the PKI file:
\brief Set time to the device \return vector<string>, vector of port names in string format -
getDeviceExternalAttributeValue
Information provided by the PKI file:
\brief Get device external attribute value \return double, attribute value- Specified by:
getDeviceExternalAttributeValuein interfaceDevice- Parameters:
attribute- Takes in a parameter of attribute- Returns:
- double Returns a double
-
setDeviceExternalAttributes
Information provided by the PKI file:
\brief Set device external attribute value \param attributeValues, QString attribute value pair in json format- Specified by:
setDeviceExternalAttributesin interfaceDevice- Parameters:
attributeValues- Takes in a parameter of attributeValues
-
addDeviceExternalAttributes
Information provided by the PKI file:
\brief Add device external attribute value \param attributeValues, QString attribute value pair in json format- Specified by:
addDeviceExternalAttributesin interfaceDevice- Parameters:
attributeValues- Takes in a parameter of attributeValues
-
subtractDeviceExternalAttributes
Information provided by the PKI file:
\brief Remove some of the device external attribute value pairs from the current list \param attributeValues, QString attribute value pair in json format- Specified by:
subtractDeviceExternalAttributesin interfaceDevice- Parameters:
attributeValues- Takes in a parameter of attributeValues
-
getDeviceExternalAttributes
Information provided by the PKI file:
\brief Returns the list of external attributes and associated values \param QString, attribute value pair in json format- Specified by:
getDeviceExternalAttributesin interfaceDevice- Returns:
- String Returns a String
-
clearDeviceExternalAttributes
public void clearDeviceExternalAttributes()- Specified by:
clearDeviceExternalAttributesin interfaceDevice
-
isOutdated
public boolean isOutdated()Information provided by the PKI file:
\brief Determine if the IoE device is outdated and needs to be updated.- Specified by:
isOutdatedin interfaceDevice- Returns:
- boolean Returns a boolean
-
restoreToDefault
public boolean restoreToDefault(boolean bMakeCopy, boolean bMarkCustomizedUpdated) Information provided by the PKI file:
\brief Restores all workspace devices to the default programming stored in the PTD file. \param bMakeCopy, also make a copy of the user?s device in the workspace \param bMarkCustomizedUpdate, if the user?s device was changed, update it and set it as updated- Specified by:
restoreToDefaultin interfaceDevice- Parameters:
bMakeCopy- Takes in a parameter of bMakeCopybMarkCustomizedUpdated- Takes in a parameter of bMarkCustomizedUpdated- Returns:
- boolean Returns a boolean
-
updateTemplateCreationTime
public void updateTemplateCreationTime()Information provided by the PKI file:
\brief The template creation time determines if a device in the workspace needs to be updated. This function Updates the template creation time to match the template PTD- Specified by:
updateTemplateCreationTimein interfaceDevice
-
runProject
Information provided by the PKI file:
\brief Runs a programming project in the mcu. \param projectName, The name of the project to run. Something like "Blink (JavaScript)" \param extraCode, does nothing. \return bool, value is true if the project existed and was started, false if not.- Specified by:
runProjectin interfaceDevice- Parameters:
projectName- Takes in a parameter of projectNameextraCode- Takes in a parameter of extraCode- Returns:
- boolean Returns a boolean
-
stopProject
Information provided by the PKI file:
\brief Stops a programming project in the mcu. \param projectName, The name of the project to stop. Something like "Blink (JavaScript)" \return bool, value is true if the project was found and stopped, false if not.- Specified by:
stopProjectin interfaceDevice- Parameters:
projectName- Takes in a parameter of projectName- Returns:
- boolean Returns a boolean
-
isProjectRunning
Information provided by the PKI file:
\brief Checks if a programming project with the given name is running. \param projectName, The name of the project to check is running. Something like "Blink (JavaScript)" \return bool, value is true if the project was found running, false if not.- Specified by:
isProjectRunningin interfaceDevice- Parameters:
projectName- Takes in a parameter of projectName- Returns:
- boolean Returns a boolean
-
runCodeInProject
Information provided by the PKI file:
\brief Runs additional code in the given project. \param projectName, The name of the project to run additional code in. Something like "Blink (JavaScript)" \param code, the code to run. If you were writing javascript you could output text like this. "Serial.println('testing output')" \return bool, value is true if the project was found and the code was run, false if not.- Specified by:
runCodeInProjectin interfaceDevice- Parameters:
projectName- Takes in a parameter of projectNamecode- Takes in a parameter of code- Returns:
- boolean Returns a boolean
-
addProgrammingSerialOutputs
Information provided by the PKI file:
\brief Writes to the programming output. Text appears in the programming output dialog. \param output, text to write.- Specified by:
addProgrammingSerialOutputsin interfaceDevice- Parameters:
output- Takes in a parameter of output
-
getProgrammingSerialOutputs
Information provided by the PKI file:
\brief Gets the programming output. It is the text that appears in the programming output dialog. \return string, value is the text that appears in the programming output dialog.- Specified by:
getProgrammingSerialOutputsin interfaceDevice- Returns:
- String Returns a String
-
clearProgrammingSerialOutputs
public void clearProgrammingSerialOutputs()Information provided by the PKI file:
\brief Clears the programming output dialog.- Specified by:
clearProgrammingSerialOutputsin interfaceDevice
-
addUserDesktopApp
- Specified by:
addUserDesktopAppin interfaceDevice- Parameters:
dirName- Takes in a parameter of dirName- Returns:
- UserDesktopAppConfig Returns a UserDesktopAppConfig
-
addUserDesktopAppFromGlobal
- Specified by:
addUserDesktopAppFromGlobalin interfaceDevice- Parameters:
id- Takes in a parameter of id- Returns:
- UserDesktopAppConfig Returns a UserDesktopAppConfig
-
getUserDesktopAppCount
public int getUserDesktopAppCount()- Specified by:
getUserDesktopAppCountin interfaceDevice- Returns:
- int Returns a int
-
getUserDesktopAppAt
- Specified by:
getUserDesktopAppAtin interfaceDevice- Parameters:
index- Takes in a parameter of index- Returns:
- UserDesktopAppConfig Returns a UserDesktopAppConfig
-
getUserDesktopAppByDir
- Specified by:
getUserDesktopAppByDirin interfaceDevice- Parameters:
dirName- Takes in a parameter of dirName- Returns:
- UserDesktopAppConfig Returns a UserDesktopAppConfig
-
getUserDesktopAppById
- Specified by:
getUserDesktopAppByIdin interfaceDevice- Parameters:
id- Takes in a parameter of id- Returns:
- UserDesktopAppConfig Returns a UserDesktopAppConfig
-
removeUserDesktopApp
- Specified by:
removeUserDesktopAppin interfaceDevice- Parameters:
dirName- Takes in a parameter of dirName
-
relinkUserDesktopApp
- Specified by:
relinkUserDesktopAppin interfaceDevice- Parameters:
oldDirName- Takes in a parameter of oldDirNamenewDirName- Takes in a parameter of newDirName
-
isDesktopAvailable
public boolean isDesktopAvailable()- Specified by:
isDesktopAvailablein interfaceDevice- Returns:
- boolean Returns a boolean
-